<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: src/Algorithm/IpLineSearch.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.17</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('IpLineSearch_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">IpLineSearch.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="IpLineSearch_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (C) 2004, 2006 International Business Machines and others.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// All Rights Reserved.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// This code is published under the Eclipse Public License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">//</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef __IPLINESEARCH_HPP__</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define __IPLINESEARCH_HPP__</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="IpAlgStrategy_8hpp.html">IpAlgStrategy.hpp</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &quot;<a class="code" href="IpIpoptCalculatedQuantities_8hpp.html">IpIpoptCalculatedQuantities.hpp</a>&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceIpopt.html">Ipopt</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span>{</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html">   17</a></span><span class="keyword">class </span><a class="code hl_define" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> <a class="code hl_class" href="classIpopt_1_1LineSearch.html">LineSearch</a>: <span class="keyword">public</span> <a class="code hl_class" href="classIpopt_1_1AlgorithmStrategyObject.html">AlgorithmStrategyObject</a></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>{</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="}">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html#af2ec1bd039c55a71595069245cd3e1b0">   23</a></span>   <a class="code hl_function" href="classIpopt_1_1LineSearch.html#af2ec1bd039c55a71595069245cd3e1b0">LineSearch</a>()</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>   { }</div>
</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html#af0662e2a2da3485f7378fe3c02457a38">   27</a></span>   <span class="keyword">virtual</span> <a class="code hl_function" href="classIpopt_1_1LineSearch.html#af0662e2a2da3485f7378fe3c02457a38">~LineSearch</a>()</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>   { }</div>
</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html#ad0913502718f88b85dc4af3c4e58eaf1">   35</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classIpopt_1_1LineSearch.html#ad0913502718f88b85dc4af3c4e58eaf1">FindAcceptableTrialPoint</a>() = 0;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html#ad33f5703834e99614d2eace2846ac5c0">   44</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classIpopt_1_1LineSearch.html#ad33f5703834e99614d2eace2846ac5c0">Reset</a>() = 0;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html#abe044f75d7c5d0ad79a58ddc3b4aab23">   59</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classIpopt_1_1LineSearch.html#abe044f75d7c5d0ad79a58ddc3b4aab23">SetRigorousLineSearch</a>(</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>      <span class="keywordtype">bool</span> rigorous</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>   ) = 0;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html#a129fe1f77e892e9baf6a1565280afa48">   66</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classIpopt_1_1LineSearch.html#a129fe1f77e892e9baf6a1565280afa48">CheckSkippedLineSearch</a>() = 0;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html#a6b2653f6e6a17c3d909b2868c772d752">   79</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classIpopt_1_1LineSearch.html#a6b2653f6e6a17c3d909b2868c772d752">ActivateFallbackMechanism</a>() = 0;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html#a1be123a0287499a6dac6a9aec4d45cbf">   93</a></span>   <a class="code hl_function" href="classIpopt_1_1LineSearch.html#a1be123a0287499a6dac6a9aec4d45cbf">LineSearch</a>(</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1LineSearch.html">LineSearch</a>&amp;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>   );</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classIpopt_1_1LineSearch.html#ac6a0e809c63dd8585b30116605bcea91">   97</a></span>   <span class="keywordtype">void</span> <a class="code hl_function" href="classIpopt_1_1LineSearch.html#ac6a0e809c63dd8585b30116605bcea91">operator=</a>(</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1LineSearch.html">LineSearch</a>&amp;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>   );</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>};</div>
</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>} <span class="comment">// namespace Ipopt</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aIpAlgStrategy_8hpp_html"><div class="ttname"><a href="IpAlgStrategy_8hpp.html">IpAlgStrategy.hpp</a></div></div>
<div class="ttc" id="aIpIpoptCalculatedQuantities_8hpp_html"><div class="ttname"><a href="IpIpoptCalculatedQuantities_8hpp.html">IpIpoptCalculatedQuantities.hpp</a></div></div>
<div class="ttc" id="aclassIpopt_1_1AlgorithmStrategyObject_html"><div class="ttname"><a href="classIpopt_1_1AlgorithmStrategyObject.html">Ipopt::AlgorithmStrategyObject</a></div><div class="ttdoc">This is the base class for all algorithm strategy objects.</div><div class="ttdef"><b>Definition</b> <a href="IpAlgStrategy_8hpp_source.html#l00034">IpAlgStrategy.hpp:35</a></div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html"><div class="ttname"><a href="classIpopt_1_1LineSearch.html">Ipopt::LineSearch</a></div><div class="ttdoc">Base class for line search objects.</div><div class="ttdef"><b>Definition</b> <a href="IpLineSearch_8hpp_source.html#l00017">IpLineSearch.hpp:18</a></div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html_a129fe1f77e892e9baf6a1565280afa48"><div class="ttname"><a href="classIpopt_1_1LineSearch.html#a129fe1f77e892e9baf6a1565280afa48">Ipopt::LineSearch::CheckSkippedLineSearch</a></div><div class="ttdeci">virtual bool CheckSkippedLineSearch()=0</div><div class="ttdoc">Check if the line search procedure didn't accept a new iterate during the last call of FindAcceptable...</div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html_a1be123a0287499a6dac6a9aec4d45cbf"><div class="ttname"><a href="classIpopt_1_1LineSearch.html#a1be123a0287499a6dac6a9aec4d45cbf">Ipopt::LineSearch::LineSearch</a></div><div class="ttdeci">LineSearch(const LineSearch &amp;)</div><div class="ttdoc">Copy Constructor.</div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html_a6b2653f6e6a17c3d909b2868c772d752"><div class="ttname"><a href="classIpopt_1_1LineSearch.html#a6b2653f6e6a17c3d909b2868c772d752">Ipopt::LineSearch::ActivateFallbackMechanism</a></div><div class="ttdeci">virtual bool ActivateFallbackMechanism()=0</div><div class="ttdoc">This method should be called if the optimization process requires the line search object to switch to...</div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html_abe044f75d7c5d0ad79a58ddc3b4aab23"><div class="ttname"><a href="classIpopt_1_1LineSearch.html#abe044f75d7c5d0ad79a58ddc3b4aab23">Ipopt::LineSearch::SetRigorousLineSearch</a></div><div class="ttdeci">virtual void SetRigorousLineSearch(bool rigorous)=0</div><div class="ttdoc">Set flag indicating whether a very rigorous line search should be performed.</div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html_ac6a0e809c63dd8585b30116605bcea91"><div class="ttname"><a href="classIpopt_1_1LineSearch.html#ac6a0e809c63dd8585b30116605bcea91">Ipopt::LineSearch::operator=</a></div><div class="ttdeci">void operator=(const LineSearch &amp;)</div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html_ad0913502718f88b85dc4af3c4e58eaf1"><div class="ttname"><a href="classIpopt_1_1LineSearch.html#ad0913502718f88b85dc4af3c4e58eaf1">Ipopt::LineSearch::FindAcceptableTrialPoint</a></div><div class="ttdeci">virtual void FindAcceptableTrialPoint()=0</div><div class="ttdoc">Perform the line search.</div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html_ad33f5703834e99614d2eace2846ac5c0"><div class="ttname"><a href="classIpopt_1_1LineSearch.html#ad33f5703834e99614d2eace2846ac5c0">Ipopt::LineSearch::Reset</a></div><div class="ttdeci">virtual void Reset()=0</div><div class="ttdoc">Reset the line search.</div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html_af0662e2a2da3485f7378fe3c02457a38"><div class="ttname"><a href="classIpopt_1_1LineSearch.html#af0662e2a2da3485f7378fe3c02457a38">Ipopt::LineSearch::~LineSearch</a></div><div class="ttdeci">virtual ~LineSearch()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition</b> <a href="IpLineSearch_8hpp_source.html#l00027">IpLineSearch.hpp:27</a></div></div>
<div class="ttc" id="aclassIpopt_1_1LineSearch_html_af2ec1bd039c55a71595069245cd3e1b0"><div class="ttname"><a href="classIpopt_1_1LineSearch.html#af2ec1bd039c55a71595069245cd3e1b0">Ipopt::LineSearch::LineSearch</a></div><div class="ttdeci">LineSearch()</div><div class="ttdoc">Default Constructor.</div><div class="ttdef"><b>Definition</b> <a href="IpLineSearch_8hpp_source.html#l00023">IpLineSearch.hpp:23</a></div></div>
<div class="ttc" id="aconfig__default_8h_html_a58bb5c104ee5ff44b7175fc992d89b0b"><div class="ttname"><a href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a></div><div class="ttdeci">#define IPOPTLIB_EXPORT</div><div class="ttdef"><b>Definition</b> <a href="config__default_8h_source.html#l00010">config_default.h:10</a></div></div>
<div class="ttc" id="anamespaceIpopt_html"><div class="ttname"><a href="namespaceIpopt.html">Ipopt</a></div><div class="ttdoc">This file contains a base class for all exceptions and a set of macros to help with exceptions.</div><div class="ttdef"><b>Definition</b> <a href="IpInexactAlgBuilder_8hpp_source.html#l00013">IpInexactAlgBuilder.hpp:14</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
